<!DOCTYPE html>
<html lang="zh-cn">

<head>
  <!-- Meta, title, CSS, favicons, etc. -->
  <meta charset="utf-8">
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <title>JAPI文档 &middot; SPECTER-DEV</title>

  <!-- Bootstrap core CSS -->
  <link type="text/css" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/css/bootstrap.min.css" />
  <link type="text/css" rel="stylesheet" href="https://v3.bootcss.com/assets/css/patch.css" />
  <link type="text/css" rel="stylesheet" href="https://v3.bootcss.com/assets/css/docs.min.css" />
  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
	  <script src="http://cdn.bootcss.com/html5shiv/3.7.0/html5shiv.js"></script>
	  <script src="http://cdn.bootcss.com/respond.js/1.4.2/respond.min.js"></script>
	<![endif]-->
  <style>
  .js-options-table>thead>tr>th:nth-child(1){width:150px;}
  </style>
</head>

<body style="font-family:'Microsoft YaHei',Arial,Helvetica,sans-serif;">
  <a class="sr-only sr-only-focusable" href="#content">Skip to main content</a>

  <!-- Docs master nav -->
  <header class="navbar navbar-static-top bs-docs-nav" id="top" role="banner">
    <div class="container">
      <div class="navbar-header">
        <button class="navbar-toggle collapsed" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <!-- <img src="../dist/images/logo.png" style="float:left;padding-top:3px;" /> -->
        <a class="navbar-brand" href="#">开发文档说明</a>
      </div>
      <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation">
        <ul class="nav navbar-nav">
          <li class="active"><a href="#">JAPI文档</a></li>
        </ul>
        <ul class="nav navbar-nav navbar-right">
          <li><a onclick="javascript:window.print();">打印</a></li>
        </ul>
      </nav>
    </div>
  </header>

  <!-- Docs page layout -->
  <div class="bs-docs-header" id="content">
    <div class="container">
      <h1 style="font-size: 36px;">JAPI接口文档：</h1>
      <p>API相关的描述介绍，请大家仔细阅读！ </p>
      <p style="font-size:16px;">@Author: Liang.Wang / @Version:1.0 </p>
    </div>
  </div>

  <div class="container bs-docs-container">
    <div class="row">
      <div class="col-md-9" role="main">
        <div class="bs-docs-section">
          <h2 id="mapping_1" class="page-header">1. 行政区划 前端控制器</h2>
          <p class="lead">行政区划 前端控制器</p>
          <p>Author: <code>Liang.Wang</code></p>
          <p>Version: <code>1.0</code></p>
          
          <hr/>
          <h3 id="mapping_1_1">1.1. 按照区域码查询详细信息</h3>
          <p>按照区域码查询详细信息</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/areacode/show/{areaCode}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">areaCode 行政区划码 ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>areaCode</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>areaCode 行政区划码</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"areaCode":"areaCode 行政区划码",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/areacode/show/{areaCode}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">对应的区划信息 </code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Inner Object</td>
                  <td><code>Areacode</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为Areacode的Object集合！</td>
                </tr>
                <tr>
                  <td>　 ↳ id</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>主键ID</td>
                </tr>
                <tr>
                  <td>　 ↳ areaCode</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>编码</td>
                </tr>
                <tr>
                  <td>　 ↳ province</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>省</td>
                </tr>
                <tr>
                  <td>　 ↳ city</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>市</td>
                </tr>
                <tr>
                  <td>　 ↳ district</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>县(区/自治县)</td>
                </tr>
                <tr>
                  <td>　 ↳ town</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>镇(街道)</td>
                </tr>
                <tr>
                  <td>　 ↳ village</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>村(社区)</td>
                </tr>
                <tr>
                  <td>　 ↳ street</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>组</td>
                </tr>
                <tr>
                  <td>　 ↳ remark</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>备注</td>
                </tr>
                <tr>
                  <td>　 ↳ state</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>　 ↳ ordering</td>
                  <td><code>Integer</code></td>
                  <td><code>N</code></td>
                  <td>排序</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":{
		"id":"主键ID",
		"areaCode":"编码",
		"province":"省",
		"city":"市",
		"district":"县(区/自治县)",
		"town":"镇(街道)",
		"village":"村(社区)",
		"street":"组",
		"remark":"备注",
		"state":"状态",
		"ordering":"排序",
	}
}</code>
            </pre></figure>
          </div>
          <hr/>
          <h3 id="mapping_1_2">1.2. 查询下一级所有区域列表</h3>
          <p>查询下一级所有区域列表</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/areacode/next/{areaCode}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">areaCode 行政区划码 ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>areaCode</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>areaCode 行政区划码</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"areaCode":"areaCode 行政区划码",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/areacode/next/{areaCode}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">下一级所有的行政区划列表 </code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>List</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Inner Object</td>
                  <td><code>Areacode</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为Areacode的List集合！</td>
                </tr>
                <tr>
                  <td>　 ↳ id</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>主键ID</td>
                </tr>
                <tr>
                  <td>　 ↳ areaCode</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>编码</td>
                </tr>
                <tr>
                  <td>　 ↳ province</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>省</td>
                </tr>
                <tr>
                  <td>　 ↳ city</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>市</td>
                </tr>
                <tr>
                  <td>　 ↳ district</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>县(区/自治县)</td>
                </tr>
                <tr>
                  <td>　 ↳ town</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>镇(街道)</td>
                </tr>
                <tr>
                  <td>　 ↳ village</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>村(社区)</td>
                </tr>
                <tr>
                  <td>　 ↳ street</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>组</td>
                </tr>
                <tr>
                  <td>　 ↳ remark</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>备注</td>
                </tr>
                <tr>
                  <td>　 ↳ state</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>　 ↳ ordering</td>
                  <td><code>Integer</code></td>
                  <td><code>N</code></td>
                  <td>排序</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":[{
		"id":"主键ID",
		"areaCode":"编码",
		"province":"省",
		"city":"市",
		"district":"县(区/自治县)",
		"town":"镇(街道)",
		"village":"村(社区)",
		"street":"组",
		"remark":"备注",
		"state":"状态",
		"ordering":"排序",
	}]
}</code>
            </pre></figure>
          </div>
          <hr/>
          <h3 id="mapping_1_3">1.3. 直辖市直接取区县列表</h3>
          <p>直辖市直接取区县列表</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/areacode/ptod/{areaCode}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">areaCode 行政区划码 ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>areaCode</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>areaCode 行政区划码</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"areaCode":"areaCode 行政区划码",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/areacode/ptod/{areaCode}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">下一级所有的行政区划列表 </code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>List</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Inner Object</td>
                  <td><code>Areacode</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为Areacode的List集合！</td>
                </tr>
                <tr>
                  <td>　 ↳ id</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>主键ID</td>
                </tr>
                <tr>
                  <td>　 ↳ areaCode</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>编码</td>
                </tr>
                <tr>
                  <td>　 ↳ province</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>省</td>
                </tr>
                <tr>
                  <td>　 ↳ city</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>市</td>
                </tr>
                <tr>
                  <td>　 ↳ district</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>县(区/自治县)</td>
                </tr>
                <tr>
                  <td>　 ↳ town</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>镇(街道)</td>
                </tr>
                <tr>
                  <td>　 ↳ village</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>村(社区)</td>
                </tr>
                <tr>
                  <td>　 ↳ street</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>组</td>
                </tr>
                <tr>
                  <td>　 ↳ remark</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>备注</td>
                </tr>
                <tr>
                  <td>　 ↳ state</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>　 ↳ ordering</td>
                  <td><code>Integer</code></td>
                  <td><code>N</code></td>
                  <td>排序</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":[{
		"id":"主键ID",
		"areaCode":"编码",
		"province":"省",
		"city":"市",
		"district":"县(区/自治县)",
		"town":"镇(街道)",
		"village":"村(社区)",
		"street":"组",
		"remark":"备注",
		"state":"状态",
		"ordering":"排序",
	}]
}</code>
            </pre></figure>
          </div>
          <hr/>
          <h3 id="mapping_1_4">1.4. 查询下面所有地区</h3>
          <p>查询下面所有地区</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/areacode/address/{areaCode}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">areaCode 行政区划码 ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>areaCode</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>areaCode 行政区划码</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"areaCode":"areaCode 行政区划码",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/areacode/address/{areaCode}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">下级所有地区行政区列表 </code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>List</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Inner Object</td>
                  <td><code>Areacode</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为Areacode的List集合！</td>
                </tr>
                <tr>
                  <td>　 ↳ id</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>主键ID</td>
                </tr>
                <tr>
                  <td>　 ↳ areaCode</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>编码</td>
                </tr>
                <tr>
                  <td>　 ↳ province</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>省</td>
                </tr>
                <tr>
                  <td>　 ↳ city</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>市</td>
                </tr>
                <tr>
                  <td>　 ↳ district</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>县(区/自治县)</td>
                </tr>
                <tr>
                  <td>　 ↳ town</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>镇(街道)</td>
                </tr>
                <tr>
                  <td>　 ↳ village</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>村(社区)</td>
                </tr>
                <tr>
                  <td>　 ↳ street</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>组</td>
                </tr>
                <tr>
                  <td>　 ↳ remark</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>备注</td>
                </tr>
                <tr>
                  <td>　 ↳ state</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>　 ↳ ordering</td>
                  <td><code>Integer</code></td>
                  <td><code>N</code></td>
                  <td>排序</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":[{
		"id":"主键ID",
		"areaCode":"编码",
		"province":"省",
		"city":"市",
		"district":"县(区/自治县)",
		"town":"镇(街道)",
		"village":"村(社区)",
		"street":"组",
		"remark":"备注",
		"state":"状态",
		"ordering":"排序",
	}]
}</code>
            </pre></figure>
          </div>
        </div><!-- ./.bs-docs-section -->
        <div class="bs-docs-section">
          <h2 id="mapping_2" class="page-header">2. 字典外部访问接口</h2>
          <p class="lead">字典外部访问接口</p>
          <p>Author: <code>Liang.Wang</code></p>
          <p>Version: <code>1.0</code></p>
          
          <hr/>
          <h3 id="mapping_2_1">2.1. 查询所有字典信息</h3>
          <p>查询所有字典信息</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/dict/all</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">There is no @param tag in the comment !</code></pre></figure>
          

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">This Api With No Param! ;</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/dict/all'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">返回所有字典信息列表</code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Any Object</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为任意类型！</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":{
		"warnning":"There is no type limit!"
	}
}</code>
            </pre></figure>
          </div>
          <hr/>
          <h3 id="mapping_2_2">2.2. 按照类别查询对应一类字典的全部可选值</h3>
          <p>按照类别查询对应一类字典的全部可选值</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/dict/list/{name}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">name 字典的类别代码,如:DISABLE_TYPE ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>name</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>name 字典的类别代码,如:DISABLE_TYPE</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"name":"name 字典的类别代码,如:DISABLE_TYPE",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/dict/list/{name}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">相应字典类型的列表</code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Any Object</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为任意类型！</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":{
		"warnning":"There is no type limit!"
	}
}</code>
            </pre></figure>
          </div>
          <hr/>
          <h3 id="mapping_2_3">2.3. 按照类别及对应的数值查询对应的中文含义</h3>
          <p>按照类别及对应的数值查询对应的中文含义</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/dict/show/{name}/{code}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">name 字典代码，如：DISABLE_TYPE ;
code 字典代码，如：1 ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>name</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>name 字典代码，如：DISABLE_TYPE</td>
                </tr>
                <tr>
                  <td>code</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>code 字典代码，如：1</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"name":"name 字典代码，如：DISABLE_TYPE",
		"code":"code 字典代码，如：1",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/dict/show/{name}/{code}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">相应字典信息，如：视力残疾</code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Any Object</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为任意类型！</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":{
		"warnning":"There is no type limit!"
	}
}</code>
            </pre></figure>
          </div>
          <hr/>
          <h3 id="mapping_2_4">2.4. 按照父级Id查询子集全部字典列表</h3>
          <p>按照父级Id查询子集全部字典列表</p>

          <p><strong>URL(1.1): </strong> <code>http://localhost:8080/project/dict/dict/son/{parentId}</code></p>

          <p><strong>Method: </strong> <code>GET</code></p>
          <p><strong>Content-Type: </strong> <code>application/x-www-form-urlencoded</code></p>
          <p><strong>Accept: </strong> <code>*/*</code></p>

          <hr/>
          <h5><strong>Request:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">parentId 父级Id ;</code></pre></figure>
          
          <p><strong>Request-Parameters:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>parentId</td>
                  <td>String</td>
                  <td><code>N</code></td>
                  <td>parentId 父级Id</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Request-Example:</strong></p>
          <div class="bs-example">
            <figure class="highlight">
              <pre>
<code class="language-js" data-lang="js"><span class="kd">var</span> <span class="nx">params</span><span class="o"> = </span>
<span class="p">{
		"parentId":"parentId 父级Id",

};</span>
<span class="c1">// 根据实际设置以上参数！</span>
<span class="nx">$</span><span class="p">http({</span>
  <span class="p">url: </span><span class="s1">'/dict/dict/son/{parentId}'</span><span class="p">,</span> 
  <span class="p">method: </span><span class="s1">'GET'</span><span class="p">,</span>
  <span class="p">headers: {</span><span class="s1">'Content-Type'</span><span class="p">: </span><span class="s1">'application/x-www-form-urlencoded'</span><span class="p">},</span>
  <span class="p">params: </span><span class="s1">params,</span>
<span class="p">}).</span><span class="nx">then</span><span class="p">(</span><span class="kd">function</span><span class="p">(response) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(response);</span>

<span class="p">}).</span><span class="nx">catch</span><span class="p">(</span><span class="kd">function</span><span class="p">(error) {</span>
  <span class="p">console.</span><span class="nx">log</span><span class="p">(error);</span>

<span class="p">});</span>
</code>
              </pre>
            </figure>
          </div>

          <hr/>
          <h5><strong>Response:</strong></h5>
          <figure class="highlight"><pre><code class="language-html" data-lang="html">相应字典类型的列表</code></pre></figure>
          
          <p><strong>Response-Fields:</strong></p>
          <div class="table-responsive">
            <table class="table table-bordered table-striped js-options-table">
              <thead>
                <tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>meta</td>
                  <td><code>Meta</code></td>
                  <td><code>N</code></td>
                  <td>响应头部</td>
                </tr>
                <tr>
                  <td>↳ success</td>
                  <td><code>boolean</code></td>
                  <td><code>N</code></td>
                  <td>状态</td>
                </tr>
                <tr>
                  <td>↳ message</td>
                  <td><code>String</code></td>
                  <td><code>N</code></td>
                  <td>消息</td>
                </tr>
                <tr>
                  <td>data</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>响应内容</td>
                </tr>
                <tr>
                  <td>↳ Any Object</td>
                  <td><code>Object</code></td>
                  <td><code>N</code></td>
                  <td>内部对象为任意类型！</td>
                </tr>
              </tbody>
            </table>
          </div>

          <p><strong>Response-example:</strong></p>
          <div class="bs-example">
            <figure class="highlight"><pre>
<code class="language-js" data-lang="js">{
	"meta":{
		"success":"状态",
		"message":"消息",
	},
	"data":{
		"warnning":"There is no type limit!"
	}
}</code>
            </pre></figure>
          </div>
        </div><!-- ./.bs-docs-section -->
      </div><!-- ./.col-md-9 -->

      <!-- 页面导航部分 -->
      <div class="col-md-3">
        <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
          <ul class="nav bs-docs-sidenav">
            <li>
              <a href="#mapping_1">1. 行政区划 前端控制器</a>
              <ul class="nav">
                <li><a href="#mapping_1_1">1.1. 按照区域码查询详细信息</a></li>
                <li><a href="#mapping_1_2">1.2. 查询下一级所有区域列表</a></li>
                <li><a href="#mapping_1_3">1.3. 直辖市直接取区县列表</a></li>
                <li><a href="#mapping_1_4">1.4. 查询下面所有地区</a></li>
              </ul>
            </li>
            <li>
              <a href="#mapping_2">2. 字典外部访问接口</a>
              <ul class="nav">
                <li><a href="#mapping_2_1">2.1. 查询所有字典信息</a></li>
                <li><a href="#mapping_2_2">2.2. 按照类别查询对应一类字典的全部可选值</a></li>
                <li><a href="#mapping_2_3">2.3. 按照类别及对应的数值查询对应的中文含义</a></li>
                <li><a href="#mapping_2_4">2.4. 按照父级Id查询子集全部字典列表</a></li>
              </ul>
            </li>
          </ul>
          <a class="back-to-top" href="#top">返回顶部</a>
        </nav>
      </div><!-- ./页面导航 -->

    </div><!-- ./.row -->
  </div><!-- ./.container bs-docs-container -->

  <!-- Footer
	================================================== -->
  <footer class="bs-docs-footer">
    <div class="container">
      <ul class="bs-docs-footer-links">
        <li><a href="#">帮助</a></li>
      </ul>
      <p>Generated At 2020-04-07 14:25:10</p>
      <p>Designed and built with all the love in the world by
        <a href="https://twitter.com/mdo" target="_blank">@mdo</a> and
        <a href="https://twitter.com/fat" target="_blank">@fat</a>. Maintained by the
        <a href="https://github.com/orgs/twbs/people">core team</a> with the help of
        <a href="https://github.com/twbs/bootstrap/graphs/contributors">our contributors</a>.
      </p>
      <p>本项目源码受
        <a rel="license" href="https://github.com/twbs/bootstrap/blob/master/LICENSE" target="_blank">MIT</a>开源协议保护，文档受
        <a rel="license" href="https://creativecommons.org/licenses/by/3.0/" target="_blank">CC BY 3.0</a> 开源协议保护。
      </p>
    </div>
  </footer>

  <!-- Bootstrap core JavaScript
	================================================== -->
  <!-- Placed at the end of the document so the pages load faster -->
  <script src="https://cdn.jsdelivr.net/npm/jquery@1.12.4/dist/jquery.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/js/bootstrap.min.js"></script>
  <script src="https://v3.bootcss.com/assets/js/docs.min.js"></script>
</body>

</html>